/*
 * Copyright (c) 1999-2012, Ecole des Mines de Nantes
 * All rights reserved.
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the Ecole des Mines de Nantes nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.unesp.ia.gridsolver.csp;

import org.kohsuke.args4j.Option;
import solver.Solver;
import solver.explanations.ExplanationFactory;
import solver.propagation.hardcoded.PropagatorEngine;

/**
 * <br/>
 *
 * @author Charles Prud'homme
 * @since 31/03/11
 */
public abstract class AbstractProblem {

    enum Level {

        SILENT(-10), QUIET(0), VERBOSE(10);
        int level;

        Level(int level) {
            this.level = level;
        }

        public int getLevel() {
            return level;
        }
    }
    @Option(name = "-l", aliases = "--log", usage = "Quiet resolution", required = false)
    Level level = Level.VERBOSE;
    @Option(name = "-s", aliases = "--seed", usage = "Seed for Shuffle propagation engine.", required = false)
    protected long seed = 29091981;
    @Option(name = "-e", aliases = "--exp-eng", usage = "Type of explanation engine to plug in")
    ExplanationFactory expeng = ExplanationFactory.NONE;
    @Option(name = "-fe", aliases = "--flatten-expl", usage = "Flatten explanations (automatically plug ExplanationFactory.SILENT in if undefined).", required = false)
    protected boolean fexp = false;
    protected Solver solver;
    private boolean userInterruption = true;

    public void printDescription() {
    }

    public Solver getSolver() {
        return solver;
    }

    public abstract void createSolver();

    public abstract void buildModel();

    public abstract void configureSearch();

    public abstract boolean optimalSolve();    
    
    public abstract boolean nextSolution();
    
    public abstract void prettyOut();

    protected void overrideExplanation() {
        if (!solver.getExplainer().isActive()) {
            if (expeng != ExplanationFactory.NONE) {
                expeng.plugin(solver, fexp);
            } else if (fexp) {
                ExplanationFactory.SILENT.plugin(solver, fexp);
            }
        }
    }

    private final boolean userInterruption() {
        return userInterruption;
    }

    public final void execute() {        
        this.printDescription();
        this.createSolver();
        this.buildModel();
        this.configureSearch();
        overrideExplanation();
        solver.set(new PropagatorEngine(solver));       
        //userInterruption = false;
    }
}
